Fix handling of entity with class names without "Entity" or "Entities" #75
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dblock
approved these changes
Jan 28, 2025
| expose :nested, using: TheseApi::Entities::Nested, documentation: { desc: 'Nested object.' } | ||
| expose :nested_child, using: TheseApi::Entities::NestedChild, documentation: { desc: 'Nested child object.' } | ||
| expose :polymorphic, using: TheseApi::Entities::Polymorphic, documentation: { desc: 'Polymorphic Model' } | ||
| expose :mixed, using: TheseApi::Entities::MixedType, documentation: { desc: 'A model with mix of types' } |
There was a problem hiding this comment.
Suggested change
| expose :mixed, using: TheseApi::Entities::MixedType, documentation: { desc: 'A model with mix of types' } | |
| expose :mixed, using: TheseApi::Entities::MixedType, documentation: { desc: 'A model with mix of types.' } |
(and let's replace Polymorphic Model with A polymorphic model. above, to be consistent?
There was a problem hiding this comment.
done here: 47e6140
Of course! All suggestions are always welcome. |
numbata
commented
Jan 28, 2025
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| ruby-version: ['3.0', '3.1', '3.2', '3.3'] |
There was a problem hiding this comment.
Hmmm.. Maybe instead of removing ruby 3.0, the specific grape version can be set instead. As a separate PR ofc.
There was a problem hiding this comment.
There was a problem hiding this comment.
That's a good idea, will merge this one, feel free to pick it up?
There was a problem hiding this comment.
Sure! Will do this.
dblock
approved these changes
Jan 30, 2025
krororo
added a commit
to krororo/grape-swagger-entity
that referenced
this pull request
Apr 28, 2025
This commit fixes an issue where specifying a class like `Time` for the `type` option in `expose` documentation resulted in an error instead of generating the correct Swagger/OpenAPI specification. This functionality was working correctly in v0.5.5 but regressed after PR ruby-grape#75, leading to the following error: ``` GrapeSwagger::Errors::UnregisteredParser: No parser registered for Time. ``` The `primitive_type?` method now uses `GrapeSwagger::DocMethods::DataType.call` to resolve the type name before checking if it's a primitive type. This ensures that types like `Time` are correctly identified as strings with the `date-time` format, restoring the previous behavior.
krororo
added a commit
to krororo/grape-swagger-entity
that referenced
this pull request
Apr 28, 2025
This commit fixes an issue where specifying a class like `Time` for the `type` option in `expose` documentation resulted in an error instead of generating the correct Swagger/OpenAPI specification. This functionality was working correctly in v0.5.5 but regressed after PR ruby-grape#75, leading to the following error: ``` GrapeSwagger::Errors::UnregisteredParser: No parser registered for Time. ``` The `primitive_type?` method now uses `GrapeSwagger::DocMethods::DataType.call` to resolve the type name before checking if it's a primitive type. This ensures that types like `Time` are correctly identified as strings with the `date-time` format, restoring the previous behavior.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves the handling of unconventional entity class names and enhances support for diverse types in Swagger documentation generation.
Changes
ambiguous_model_type?to correctly identify entities with non-standard class names.primitive_type?for clearer handling of primitives and additional non-class types (string, array).